EinhugurWord.Paragraph

Class which represents paragraphs in the document.

Paragraphs can be top level or can exist inside TableCell objects.

Paragraphs contain zero too many Runs. The runs actually carry the text parts and the styling for each part.

Note that Paragraph can also represent Page Break.

EinhugurWord.DocumentItem
Paragraph

class EinhugurWord.Paragraph

Constructors

Paragraph (private)

Private constructor.

Properties

Alignment	Alignment for the paragraph.
IsPageBreak	Returns true if the paragraph is page break
LanguageCode	Returns the language code for the Paragraph or empty string. (Read only property)
ListIndent	Returns list indent instance for the paragraph or nil if there was no list indent on the paragraph.
ListIndentLevel	Returns ListIndentLevel for the paragraph.
LogicalParagraphItemCount	Returns the number of logical paragraph items.
LogicalRunCount	Returns the number of logical runs.
ParagraphItemCount	Returns number of ParagraphItems in the Paragraph.
RunCount	Returns number of runs in the Paragraph.
Section	Returns section object for the given paragraph or nil if the paragraph object has no section.
Style	Sets or gets predefined ParagraphStyle for the Paragraph. When reading then nil will be returned no paragraph style has been set.
Text	Returns combined text for all Runs in the Paragraph.

Methods

AddBookmarkAround	Adds bookmark around eerie of paragraph items.
AddBookmarkAround	Adds bookmark around paragraph item.
AppendDateField	Appends date field into the paragraph.
AppendHyperlink	Adds hyperlink to the paragraph.
AppendHyperlinkField	Appends hyperlink field to the paragraph.
AppendRun	Appends run to the paragraph.
AppendRun	Appends run at back of the paragraph, creating one run for the image data passed in with this method. (This variation of the AppendRun is to embed images).
AppendShape	Appends new shape to the paragraph. This function calls AppendShapeRun, creating run, then it fetches the shape within the run.
AppendShapeGroup	Appends shape group to the paragraph, and first shape in the group is also created to make the shape group valid. This function calls AppendShapeGroupRun, creating run, then it fetches the shape within the run.
AppendShapeGroupRun	Appends shape group to the paragraph, and first shape in the group is also created to make the shape group valid. A run is created, and you can get the shape from within the Run. If you do not care about getting handle to the Run then use the AppendShapeGroup function which only returns the shape group.
AppendShapeRun	Appends new shape to the paragraph. This function calls AppendShapeRun, creating run, then it fetches the shape within the run. A run is created, and you can get the shape from within the Run. If you do not care about getting handle to the Run then use the AppendShape function which only returns the shape group.
AppendTimeField	Appends time field into the paragraph.
ApplyFieldData	Applies field data to the given Paragraph only.
FirstLineIndent	Gets or set first-line indent for the paragraph.
InserPageBreakAfter (Inherited)	Inserts page break after this document item.
InserPageBreakBefore (Inherited)	Inserts page break before this document item.
InsertParagraphAfter (Inherited)	Inserts paragraph after this document item.
InsertParagraphBefore (Inherited)	Inserts paragraph before this document item.
InsertSectionBreakAfter (Inherited)	Inserts section break after this document item.
InsertSectionBreakBefore (Inherited)	Inserts section break before this document item.
LeftIndent	Gets or set left indent for the paragraph.
LogicalParagraphItem	Fetches ParagraphItem at given index, grouping runs fields that use complex runs into one.
LogicalParagraphItems	Returns ParagraphItemIterator for the items in the paragraph, grouping run fields that use complex runs into one. This function is for using with for each statements.
LogicalRun	Fetches Run at given index, grouping runs fields that use complex runs into one.
LogicalRuns	Returns RunIterator for the runs in the paragraph, grouping run fields that use complex runs into one. This function is for using with for each statements.
ParagraphItem	Fetches ParagraphItem at given index.
ParagraphItems	Returns ParagraphItemIterator for the items in the paragraph. This function is for using with for each statements.
RemoveParagraphItem	Removes ParagraphItem from the Paragraph.
RightIndent	Gets or set right indent for the paragraph.
Run	Fetches Run at given index.
Runs	Returns RunIterator for the runs in the paragraph. This function is for using with for each statements.
SetLanguageCode	Sets language code for the Paragraph and optionally all runs under the paragraph.
SetListIndent	Sets list indent for the paragraph.

Supported Platforms:

macOS Intel 64 bit

macOS Apple Silicon

Windows 32 bit

Windows 64 bit

Windows ARM 64 bit

Linux 32 bit

Linux 64 bit

Linux ARM 32 bit

Linux ARM 64 bit

iOS